SlkStore.GetMemberships Method (SPWeb, IEnumerable<SlkUser>, IEnumerable<SlkUser>, out ReadOnlyCollection<string>, out string)

Retrieves the lists of instructors, learners, and learner groups from a given SharePoint SPWeb. Returns a Boolean value indicating whether information about any instructors or learners could not be retrieved.

Parent Type: SlkStore

Namespace: Microsoft.SharePointLearningKit

Assembly: Microsoft.SharePointLearningKit.dll

Syntax
C#

public SlkMemberships GetMemberships (
SPWeb spWeb,
IEnumerable<SlkUser> additionalInstructors,
IEnumerable<SlkUser> additionalLearners,
out ReadOnlyCollection<string> groupFailures,
out string groupFailureDetails

)

Parameters

spWeb

The SPWeb to retrieve information from.

additionalInstructors

A list of instructors to add to those in the returned SlkMemberships.Instructors list. The resulting combined list is sorted and duplicates are removed. SlkUser.SPUser is ignored and may be null for items in additionalInstructors. If additionalInstructors is null it is ignored.

additionalLearners

A list of learners to add to those in the returned SlkMemberships.Learners list. The resulting combined list is sorted and duplicates are removed. SlkUser.SPUser is ignored and may be null for items in additionalLearners. If additionalLearners is null it is ignored.

groupFailures

If one or more groups could not be enumerated, then this parameter is set to a collection of the names of those groups. Otherwise, this parameter is set to null.

groupFailureDetails

If one or more groups could not be enumerated, then this parameter is set to additional information (beyond groupFailures) that is appropriate for storing in an error log for later review by an administrator. This information may contain security details that are inappropriate for a browser user to see. If no group enumeration problem occurs, this parameter is set to null.

Exceptions
Exception type Condition
InvalidOperationException

spWeb is not in the SPSite that this SlkStore is associated with.

UnauthorizedAccessException

The user is not a Reader on spWeb.

NotAnInstructorException

The user is not an instructor on spWeb

Remarks

Security:  Fails if the current user doesn't have SLK instructor and SharePoint "Reader" permissions on spWeb.